Move conversion of PR diff-range paths to absolute paths#3248
Draft
Move conversion of PR diff-range paths to absolute paths#3248
Conversation
c7c3abd to
83a0d11
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR moves the conversion of PR diff-range paths to absolute paths from getDiffRanges in diff-informed-analysis-utils.ts to writeDiffRangeDataExtensionPack in analyze.ts. This refactoring enables getDiffRanges to be used from the init action in future changes, as it will now return relative paths instead of absolute paths. The conversion to absolute paths now happens when writing the extension pack, which is where the absolute paths are actually required.
Key Changes
getDiffRangesnow returns relative file paths instead of absolute pathsdiffRangeExtensionPackContents(new function) performs the path conversion when generating the extension packfilterAlertsByDiffRangenow compares relative paths instead of absolute paths
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/diff-informed-analysis-utils.ts | Removes absolute path conversion from getDiffRanges, now returns relative paths |
| src/diff-informed-analysis-utils.test.ts | Updates test expectations to match relative paths returned by getDiffRanges |
| src/analyze.ts | Adds diffRangeExtensionPackContents function that converts relative paths to absolute when creating extension pack |
| src/analyze.test.ts | Adds unit test for diffRangeExtensionPackContents function |
| src/upload-lib.ts | Updates filterAlertsByDiffRange to compare relative paths, exports function for testing |
| src/upload-lib.test.ts | Adds unit test for filterAlertsByDiffRange function |
| src/testdata/pr-diff-range.yml | New test fixture for extension pack content |
| src/testdata/valid-sarif-diff-filtered.sarif | New test fixture for filtered SARIF output |
83a0d11 to
a855e60
Compare
a855e60 to
4eb2475
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Diff-informed analysis expects paths in the diff-range extension pack to be absolute paths. The conversion to absolute paths currently happens within
getDiffRangesindiff-informed-analysis-utils.ts. This PR moves the conversion towriteDiffRangeDataExtensionPackinanalyze.tsinstead to allowgetDiffRangesto be used from theinitaction in a future PR. As a result the diff-range paths written topr-diff-range.jsonwill be relative instead of absolute after this PR. This also requires a change tofilterAlertsByDiffRangeinupload-libto filter based on relative paths instead of absolute paths.The actual change occurs in commit 4. Commits 1 and 3 adds unit tests for affected functions and commit 2 exposes a function for testing.
Diff-informed analysis is guarded by the
diff_informed_queriesfeature flag. Thediff_informed_queriesflag is already fully rolled out.Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
analysis-kinds: code-scanning).analysis-kinds: code-quality).upload-sarif).How did/will you validate this change?
.test.tsfiles).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Merge / deployment checklist